home *** CD-ROM | disk | FTP | other *** search
/ Amiga Game-Power / Amiga Game-Power.iso / anwendungen / disk salv / bankn / banknq.doc < prev    next >
Text File  |  1994-05-20  |  13KB  |  265 lines
  1.                               Query Instructions
  2.        
  3.        
  4.        The Query program will  allow  you  to  produce a report based on
  5.        your selection,  sorting  and  formatting  specifications.   Upon
  6.        entry, you must use the Menu to  open  both  a query command file
  7.        and a database.  You may  use  the  editor  to build a customized
  8.        query command file or you may  load  a stored query command file.
  9.        Query command files are constructed  by entering Select, Sort and
  10.        Report commands.
  11.        
  12.        Upon opening a  database,  you  will  be  presented  with  a data
  13.        dictionary.  The data dictionary gives  a list of data names that
  14.        can be used to display or print values contained in the database.
  15.        
  16.        The SELECT command allows you to specify  some selection criteria
  17.        to be used to determine which  database  entries will be included
  18.        in you output display or report.  For example,
  19.        
  20.             select
  21.             (payee = "Allstate" or "State Farm") and amount > 100.00"
  22.        
  23.        specifies that the database is to be searched for Payees with the
  24.        name of "Allstate" or  "State  Farm"  with  an  Amount > $100.00.
  25.        Note that the Select parameters  contain  parentheses  to prevent
  26.        ambiguities.  If there is  a  possibility  that  the  key word or
  27.        phrase you are looking for  contains  occurrences with both upper
  28.        and lower case letters, you must check for both, e.g., "Allstate"
  29.        or "allstate".  Another  method  is  to  use  the wild character,
  30.        e.g., "?llstate".
  31.        
  32.        The SORT command allows you to specify  the sequence in which the
  33.        selected records are to be displayed or printed.  For example,
  34.        
  35.             sort:
  36.             date, payee
  37.        
  38.        specifies that the selected database  entries are to be sorted in
  39.        Payee sequence within Date.  A maximum of five Sort fields may be
  40.        specified.   Dates  are   automatically  placed  in  the  correct
  41.        sequence according to the year,  e.g.,  "12/31/87" will be sorted
  42.        before "01/01/88".
  43.        
  44.        The REPORT command allows you to specify the format of the output
  45.        display or report.  For example,
  46.        
  47.             report
  48.             date, col 13, type, col 18, payee, col 44, amount
  49.        
  50.        specifies that the Date, Type, Payee  and Amount for the selected
  51.        records are to be displayed.   Further,  it is specified that the
  52.        Date is to be displayed beginning in column 1, the Type in column
  53.        13, the Payee in column 18 and  Amount  in column 44.  The Report
  54.        specification  parameters  may  be  very  simple  or very complex
  55.        depending upon the skill of the  user.   The Report specification
  56.        parameters can be classified as either describing "when to do it"
  57.        or "what to do".
  58.        
  59.        When To Do It:
  60.                 
  61.                 page_top - specifies that subsequent functions are to be
  62.                 executed at the top each printed page or screen.
  63.                 
  64.                 page_bottom - specifies that subsequent functions are to
  65.                 the executed  at  the  bottom  of  each  printed page or
  66.                 screen.
  67.                 
  68.                 report_top - specifies that subsequent  functions are to
  69.                 be executed only at the beginning of the output report.
  70.                 
  71.                 report_bottom - specifies that  subsequent functions are
  72.                 to executed only at the end of the report.
  73.                 
  74.                 top(<data-name>) -  specifies  that subsequent functions
  75.                 are to be executed after there  has been a change in the
  76.                 content  of   <data-name>.    For  example,  top(Payee).
  77.                 Normally, the specified  data-name  will  be the same as
  78.                 the sort sequence.
  79.                 
  80.                 bottom(<data-name>)   -   specifies    that   subsequent
  81.                 functions are to be executed before there is a change in
  82.                 the content of data-name.  For example, bottom(EC).
  83.                 
  84.                 detail - specifies that the subsequent  functions are to
  85.                 be executed for each selected database entry.
  86.                 
  87.        What To Do:
  88.        
  89.                 print - specifies that all output is to be routed to the
  90.                 printer.  Default values  for  tm, bm and bod are set to
  91.                 4, 8, and 54 respectively.
  92.                 
  93.                 display - specifies that  all  output is to be routed to
  94.                 the screen.  "Display" is  the  output default.  Default
  95.                 values for tm,  bm  and  bod  are  set  to  0, 0, and 22
  96.                 respectively.
  97.                 
  98.                 tm nn - sets the top  margin  for  the output display or
  99.                 report to the value specified by nn.
  100.                 
  101.                 bm nn - sets the bottom margin for the output display or
  102.                 report to the value specified by nn.
  103.                 
  104.                 bod nn - sets the body of  the  output display or report
  105.                 to the value specified by nn.  The sum of tm, bm and bod
  106.                 must equal the desired page length.
  107.                 
  108.                 <data-name> -  causes  the  specified  data  name  to be
  109.                 printed  or  displayed.   For   example,  "Payee"  is  a
  110.                 data-name.
  111.                 
  112.                 "literal" - causes the  specified  literal to be printed
  113.                 or  displayed.   For  example,  "The  result  is:"  is a
  114.                 literal.
  115.                 
  116.                 trim(<data-name>) - caused the specified data name to be
  117.                 printed or displayed after all trailing spaces have been
  118.                 eliminated.  For example, "trim(Payee)".
  119.                 
  120.                 total(<data-name>) - specifies  that the summed value of
  121.                 <data-name> is to be  printed  or displayed.  An numeric
  122.                 data item  from the dictionary or a numeric literal must
  123.                 be   substituted   for   <data-name>.     For   example,
  124.                 "total(amount)".   "total(1)"  can  be used to provide a
  125.                 count of the transactions.
  126.                 
  127.                 cum(<data-name>)  -  same  as  "total"  except  that the
  128.                 accumulator is not  reset  after  displaying  the total.
  129.                 This function is used to produce a running balance.
  130.                 
  131.                 spacer nn - causes  nn  spaces  to  be  inserted between
  132.                 output data items.  The default is 1.
  133.                 
  134.                 col nn - causes  the  next  specified  data  item  to be
  135.                 displayed or printed in the column specified by nn.
  136.                 
  137.                 skip n - causes n lines to be  skipped before displaying
  138.                 or printing the next data item.  If n is not provided, 1
  139.                 is assumed.
  140.                 
  141.                 pause - causes a pause in the output process until a key
  142.                 (any key) is depressed.
  143.                 
  144.                 eject - if "print"  has  been  specified,  this  command
  145.                 causes the paper to be  ejected  to  the top of the next
  146.                 page; otherwise, the screen will be cleared.
  147.                 
  148.                 
  149.                 EDITING MASKS
  150.                 
  151.                 Numeric Editing Masks may  be  used  to cause predefined
  152.                 characters to be imbedded  within  displayed  or printed
  153.                 numeric items.  Numeric items are identified in the data
  154.                 dictionary with  the  character  "n"  following the data
  155.                 name.  The masks must be constructed  as an alphanumeric
  156.                 literal whose  first  character  is  "%".  If the second
  157.                 character of the mask  literal  is  other than a numeric
  158.                 character, that  character  will  be  placed in the next
  159.                 left most position before  the  resulting edited numeric
  160.                 value.
  161.                 
  162.                 Examples:
  163.                 
  164.                      Input Values       Mask         Output
  165.                 
  166.                          01000        "%9,999"        1,000
  167.                 
  168.                          25245      "%$99,999"      $25,245
  169.                 
  170.                          -5643     "%$999,999"      $-5,643
  171.                 
  172.                 Alphanumeric  Editing   Masks   may  be  used  to  cause
  173.                 predefined characters to be imbedded within displayed or
  174.                 printed alphanumeric or date  items.  Alphanumeric items
  175.                 are identified in the data dictionary with the character
  176.                 "c" following the data name.   Date items are identified
  177.                 in the dictionary with the  character  "d" following the
  178.                 data  name.   The  mask   must   be  constructed  as  an
  179.                 alphanumeric literal whose first character is "%".
  180.                 
  181.                 Examples:
  182.                 
  183.                      Input Values        Mask        Output
  184.                 
  185.                        123456789     "%@@@-@@-@@@@"  123-45-6789
  186.                 
  187.                        102786        "%@@/@@/@@"     10/27/86
  188.                 
  189.        
  190.        Here is an example of a more complex query construction:
  191.        
  192.        
  193.        select
  194.        (ec = "UE" or "UW" or "UP") and date = "????88" and type = "C"
  195.        
  196.        sort
  197.        ec
  198.        
  199.        report
  200.        print date "%@@/@@/@@" payee ec amount "%9,999,999.99" bottom(ec)
  201.        total(amount) "%9,999,999.99"
  202.        
  203.        
  204.        This query  selects  transactions  with  Expense Codes of "UE" or
  205.        "UW" or "UP" that have a Date  ending  with "88" that also have a
  206.        Type of "C".  Note that the  question  mark (?) is used as a wild
  207.        character, i.e., it  is  used  to  denote  "any  character".  The
  208.        output report is to be printed and  will contain the Date, Payee,
  209.        Expense Code and Amount.  A total  will be printed when there has
  210.        been a change in the expense code.
  211.        
  212.        
  213.        Several query command file  examples  have  been included on your
  214.        Bank'n diskette.  Use these  query  command files, or modify them
  215.        to fit your needs.
  216.        
  217.        
  218.        Rules:
  219.        
  220.             (1)  The Select statement may contain these operators:
  221.        
  222.                     =  Equal to
  223.                     <> Unequal to
  224.                     <  Less than
  225.                     >  Greater than
  226.                     <= Less than or equal to
  227.                     >= Greater than or equal to
  228.        
  229.             (2)  The field on the left side  of  the  operator must be a
  230.        data name from the dictionary.
  231.        
  232.             (3)  The field on the  right  side  of  the  operator may be
  233.        either a data name or  literal.    Literals  must  be enclosed in
  234.        double quotes.
  235.        
  236.             (4)  In the case of equal and unequal,  the data name on the
  237.        left side of the operator is searched  for any occurrences of the
  238.        data specified on the right of the operator.
  239.        
  240.             (5)  The length of the item to the right of the operator may
  241.        not be greater than the  length  of  the  item to the left of the
  242.        operator.
  243.        
  244.             (6)  When used in a literal, the "?"  is wild.  For example,
  245.        to select all records in the database enter:
  246.        
  247.                    select
  248.                    date  = "?"
  249.        
  250.             (7)  Commas may used to improve readability; otherwise, they
  251.        serve no useful purpose.
  252.        
  253.             (8)  All data names and commands must be in lower case.
  254.        
  255.             (9)  When a vertical bar  "|"  is  encountered  in the query
  256.        command file,  the  remainder  of  the  line  is  assumed to be a
  257.        comment.
  258.        
  259.        If your printer carriage is 80 columns in width, try setting your
  260.        printer preferences for compressed mode in order to print reports
  261.        that are greater than  80  characters  in  width.   Also, if your
  262.        printed output does not have the expected  appearance, check your
  263.        printer preferences.
  264.  
  265.